From dd92af8c0590edefa117adc41cc5b5a424535ed3 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 3 Dec 2001 21:28:47 +0000 Subject: [PATCH] Updates. * gdk/tmpl/input_devices.sgml, gdk/gdk-sections.txt, gdk/tmpl/windows.sgml: Updates. --- docs/reference/ChangeLog | 5 + docs/reference/gdk/gdk-sections.txt | 26 +++-- docs/reference/gdk/tmpl/colors.sgml | 109 +++++++-------------- docs/reference/gdk/tmpl/general.sgml | 4 +- docs/reference/gdk/tmpl/input_devices.sgml | 64 ++++++------ docs/reference/gdk/tmpl/keys.sgml | 40 +++++--- docs/reference/gdk/tmpl/windows.sgml | 5 +- 7 files changed, 122 insertions(+), 131 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index ac8cc55d3a..9221783e5a 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2001-12-03 Matthias Clasen + + * gdk/tmpl/input_devices.sgml, + gdk/gdk-sections.txt, gdk/tmpl/windows.sgml: Updates. + 2001-12-02 Matthias Clasen * gdk/tmpl/dnd.sgml: Updates. diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index 2cdca0c5f5..493bc693e1 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -155,6 +155,7 @@ gdk_image_unref gdk_image_destroy gdk_image_get_colormap gdk_image_set_colormap + gdk_image_put_pixel gdk_image_get_pixel @@ -317,7 +318,6 @@ gdk_font_get_type Drawing Primitives drawing GdkDrawable -GdkDrawableClass gdk_drawable_ref gdk_drawable_unref gdk_drawable_set_data @@ -365,6 +365,7 @@ GDK_DRAWABLE_CLASS GDK_IS_DRAWABLE_CLASS +GdkDrawableClass gdk_draw_bitmap @@ -372,7 +373,6 @@ gdk_draw_bitmap Graphics Contexts gcs GdkGC -GdkGCClass GdkGCValues GdkGCValuesMask @@ -418,7 +418,6 @@ gdk_gc_offset GDK_GC GDK_TYPE_GC GDK_IS_GC -gdk_gc_get_type GDK_GC_CLASS GDK_GC_GET_CLASS GDK_IS_GC_CLASS @@ -430,6 +429,10 @@ GDK_TYPE_GC_VALUES_MASK GDK_TYPE_JOIN_STYLE GDK_TYPE_LINE_STYLE GDK_TYPE_SUBWINDOW_MODE + + +GdkGCClass +gdk_gc_get_type
@@ -458,12 +461,12 @@ GDK_TYPE_VISUAL_TYPE GDK_TYPE_VISUAL GDK_IS_VISUAL GDK_IS_VISUAL_CLASS -GdkVisualClass GDK_VISUAL GDK_VISUAL_CLASS GDK_VISUAL_GET_CLASS +GdkVisualClass gdk_visual_get_type
@@ -713,6 +716,8 @@ gdk_region_spans_intersect_foreach GDK_TYPE_OVERLAP_TYPE GDK_TYPE_RECTANGLE + + gdk_rectangle_get_type @@ -730,7 +735,6 @@ gdk_threads_mutex Keyboard Handling keys GdkKeymap -GdkKeymapClass GdkKeymapKey GdkKeyInfo gdk_keymap_get_default @@ -754,21 +758,24 @@ gdk_keyval_is_lower gdk_keyval_to_unicode gdk_unicode_to_keyval + GDK_KEYMAP GDK_IS_KEYMAP GDK_TYPE_KEYMAP -gdk_keymap_get_type GDK_KEYMAP_CLASS GDK_IS_KEYMAP_CLASS GDK_KEYMAP_GET_CLASS + + +GdkKeymapClass +gdk_keymap_get_type
Input Devices input_devices GdkDevice -GdkDeviceClass GdkInputSource GdkInputMode GdkDeviceKey @@ -803,9 +810,10 @@ GDK_DEVICE_GET_CLASS GDK_IS_DEVICE GDK_IS_DEVICE_CLASS GDK_TYPE_DEVICE -gdk_device_get_type +GdkDeviceClass +gdk_device_get_type GDK_MAX_TIMECOORD_AXES
@@ -917,6 +925,8 @@ gdk_cursor_destroy GDK_TYPE_CURSOR_TYPE GDK_TYPE_CURSOR + + gdk_cursor_get_type diff --git a/docs/reference/gdk/tmpl/colors.sgml b/docs/reference/gdk/tmpl/colors.sgml index 47396e8f88..8f5fa1eb26 100644 --- a/docs/reference/gdk/tmpl/colors.sgml +++ b/docs/reference/gdk/tmpl/colors.sgml @@ -47,75 +47,34 @@ gdk_color_change() will probably become aliases. The #GdkColor structure is used to describe an allocated or unallocated color. - - - - - - -pixel -For allocated colors, the value used to -draw this color on the screen. - - - -red -The red component of the color. This is -a value between 0 and 65535, with 65535 indicating -full intensitiy. - - - -green -the blue component of the color. - - - -blue -the green component of the color.. - - - -@pixel: -@red: -@green: -@blue: +@pixel: For allocated colors, the value used to + draw this color on the screen. +@red: The red component of the color. This is + a value between 0 and 65535, with 65535 indicating + full intensitiy. +@green: The blue component of the color. +@blue: The green component of the color. + -The colormap structure contains the following public -fields. - - - - - - -size -For pseudo-color colormaps, the number of colors -in the colormap.. - - - -colors -An array containing the current values in the -colormap. This can be used to map from pixel values -back to RGB values. This is only meaningful for -pseudo-color colormaps. - - - +The colormap structure contains the following public fields. @parent_instance: -@size: -@colors: +@size: For pseudo-color colormaps, the number of colors + in the colormap. +@colors: An array containing the current values in the + colormap. This can be used to map from pixel values + back to RGB values. This is only meaningful for + pseudo-color colormaps. + -Create a new colormap for the given visual. +Creates a new colormap for the given visual. @visual: a #GdkVisual. @@ -162,7 +121,7 @@ explanation of the size of a colormap.) -Change the value of the first @ncolors in a private colormap +Changes the value of the first @ncolors in a private colormap to match the values in the colors array in the color map. This function is obsolete and should not be used. See gdk_color_change(). @@ -196,7 +155,7 @@ Allocates colors from a colormap. -Allocate a single color from a colormap. +Allocates a single color from a colormap. @colormap: a #GdkColormap. @@ -214,7 +173,7 @@ filled in if allocation succeeds. -Free previously allocated colors. +Frees previously allocated colors. @colormap: a #GdkColormap. @@ -234,7 +193,7 @@ Free previously allocated colors. -Return the visual for which a given colormap was created. +Returns the visual for which a given colormap was created. @colormap: a #GdkColormap. @@ -243,7 +202,7 @@ Return the visual for which a given colormap was created. -Change the value of the first @ncolors colors in +Changes the value of the first @ncolors colors in a private colormap. This function is obsolete and should not be used. See gdk_color_change(). @@ -255,7 +214,7 @@ should not be used. See gdk_color_change(). -Make a copy of a color structure. The result +Makes a copy of a color structure. The result must be freed using gdk_color_free(). @@ -265,7 +224,7 @@ must be freed using gdk_color_free(). -Free a color structure created with +Frees a color structure created with gdk_color_copy(). @@ -274,10 +233,10 @@ gdk_color_copy(). -Allocate colors from a colormap. This function +Allocates colors from a colormap. This function is obsolete. See gdk_colormap_alloc_colors(). For full documentation of the fields, see -the Xlib documentation for XAllocColorCells. +the Xlib documentation for XAllocColorCells(). @colormap: a #GdkColormap. @@ -295,7 +254,7 @@ the Xlib documentation for XAllocColorCells. -Free colors allocated with gdk_colors_alloc(). This +Frees colors allocated with gdk_colors_alloc(). This function is obsolete. See gdk_colormap_free_colors(). @@ -308,7 +267,7 @@ function is obsolete. See gdk_colormap_free_colors(). -Return the white color for a given colormap. The resulting +Returns the white color for a given colormap. The resulting value has already allocated been allocated. @@ -319,7 +278,7 @@ value has already allocated been allocated. -Return the black color for a given colormap. The resulting +Returns the black color for a given colormap. The resulting value has already benn allocated. @@ -330,7 +289,7 @@ value has already benn allocated. -Parse a textual specification of a color and fill in +Parses a textual specification of a color and fill in the red, green, and blue fields of a @@ -350,7 +309,7 @@ such as 305050. -Allocate a single color from a colormap. +Allocates a single color from a colormap. This function is obsolete. See gdk_colormap_alloc_color(). @@ -363,7 +322,7 @@ filled in. -Change the value of a color that has already +Changes the value of a color that has already been allocated. If @colormap is not a private colormap, then the color must have been allocated using gdk_colormap_alloc_colors() with the @@ -379,7 +338,7 @@ and the new value in the remaining fields. -Compare two colors. +Compares two colors. @colora: a #GdkColor. @@ -395,7 +354,5 @@ table that stores #GdkColor's. @colora: a #GdkColor. @Returns: The hash function appled to @colora - -@colorb: NOT USED. diff --git a/docs/reference/gdk/tmpl/general.sgml b/docs/reference/gdk/tmpl/general.sgml index ad91d7cc88..db3b379622 100644 --- a/docs/reference/gdk/tmpl/general.sgml +++ b/docs/reference/gdk/tmpl/general.sgml @@ -91,8 +91,8 @@ set on all X windows created by the application to point to the leader window. See the X Session Management Library documentation for more information on session management and the Inter-Client Communication Conventions Manual -(ICCCM) for information on the WM_CLIENT_LEADER property. (Both documents are -part of the X Windows distribution.) +(ICCCM) for information on the WM_CLIENT_LEADER property. +(Both documents are part of the X Windows distribution.) @sm_client_id: the client id assigned by the session manager when the diff --git a/docs/reference/gdk/tmpl/input_devices.sgml b/docs/reference/gdk/tmpl/input_devices.sgml index 4bbdabeb8a..4984726ad6 100644 --- a/docs/reference/gdk/tmpl/input_devices.sgml +++ b/docs/reference/gdk/tmpl/input_devices.sgml @@ -50,10 +50,7 @@ tilt to the right or down.) One additional field in each event is the source field, which contains an enumeration value describing the type of device; this currently -can be one of -%GDK_SOURCE_MOUSE, - %GDK_SOURCE_PEN, -%GDK_SOURCE_ERASER, +can be one of %GDK_SOURCE_MOUSE, %GDK_SOURCE_PEN, %GDK_SOURCE_ERASER, or %GDK_SOURCE_CURSOR. This field is present to allow simple applications to (for instance) delete when they detect eraser devices without having to keep track of complicated per-device @@ -83,7 +80,8 @@ gdk_device_set_key(). The interfaces in this section will most likely be considerably modified in the future to accomodate devices that may have different -sets of additional valuators than the pressure xtilt and ytilt. +sets of additional valuators than the pressure xtilt +and ytilt. @@ -93,18 +91,23 @@ sets of additional valuators than the pressure xtilt and ytilt. - +A GdkDevice structure contains +a detailed description of an extended input device. All +fields are read-only; but you can use gdk_device_set_source(), +gdk_device_set_mode(), gdk_device_set_key() and gdk_device_set_axis_use() +to configure various aspects of the device. @parent_instance: -@name: -@source: -@mode: -@has_cursor: -@num_axes: -@axes: -@num_keys: -@keys: +@name: the name of this device. +@source: the type of this device. +@mode: the mode of this device +@has_cursor: %TRUE if the pointer follows device motion. +@num_axes: the length of the @axes array. +@axes: an array of #GdkDeviceAxis, describing the axes of this device. +@num_keys: the length of the @keys array. +@keys: an array of #GdkDeviceKey, describing the mapped macro buttons + of this device. @@ -140,9 +143,9 @@ An enumeration that describes the mode of an input device. -The #GdkDeviceKey structure contains information -about the mapping of one device macro button onto -a normal X key event. It has the following fields: +The GdkDeviceKey structure contains information +about the mapping of one device macro button onto a normal X key event. +It has the following fields: @keyval: the keyval to generate when the macro button is pressed. @@ -151,12 +154,13 @@ a normal X key event. It has the following fields: - +The GdkDeviceAxis structure contains information +about the range and mapping of a device axis. -@use: -@min: -@max: +@use: specifies how the axis is used. +@min: the minimal value that will be reported by this axis. +@max: the maximal value that will be reported by this axis. @@ -249,16 +253,16 @@ Gets the current state of a device. - +Obtains the motion history for a device. -@device: -@window: -@start: -@stop: -@events: -@n_events: -@Returns: +@device: a #GdkDevice. +@window: the window wrt. which the event coordinates will be translated. +@start: only return events newer than this timestamp. +@stop: only return events older than this timestamp. +@events: location to return a newly-allocated array of #GdkTimeCoord. +@n_events: location to return the length of @events. +@Returns: %TRUE if the @events were successfully filled. @@ -277,7 +281,7 @@ motion history. It contains the following fields: @time: The timestamp for this event. -@axes: +@axes: the values of the device's axes. diff --git a/docs/reference/gdk/tmpl/keys.sgml b/docs/reference/gdk/tmpl/keys.sgml index 2460fd93fa..b7236fd5d5 100644 --- a/docs/reference/gdk/tmpl/keys.sgml +++ b/docs/reference/gdk/tmpl/keys.sgml @@ -10,8 +10,8 @@ Key values are the codes which are sent whenever a key is pressed or released. They appear in the keyval field of the #GdkEventKey structure, which is passed to signal handlers for the "key-press-event" and "key-release-event" signals. -The complete list of key values can be found in the <gdk/gdkkeysyms.h> -header file. <gdk/gdkkeysyms.h> is not included in <gtk/gtk.h>, +The complete list of key values can be found in the <gdk/gdkkeysyms.h> +header file. <gdk/gdkkeysyms.h> is not included in <gtk/gtk.h>, it must be included independently, because the file is quite large. @@ -81,7 +81,12 @@ gdk_keymap_translate_keyboard_state() just to get the keyval. - +A GdkKeymap defines the translation from keyboard state +(including a hardware key, a modifier mask, and active keyboard group) +to a keyval. This translation has two phases. The first phase is +to determine the effective keyboard group and level for the keyboard +state; the second phase is to look up the keycode/group/level triplet +in the keymap and see what keyval it corresponds to. @parent_instance: @@ -94,12 +99,21 @@ gdk_keymap_translate_keyboard_state() just to get the keyval. - +A GdkKeymapKey is a hardware key that can +be mapped to a keyval. -@keycode: -@group: -@level: +@keycode: the hardware keycode. This is an identifying number for a + physical key. +@group: indicates movement in a horizontal direction. Usually groups are used + for two different languages. In group 0, a key might have two English + characters, and in group 1 it might have two Hebrew characters. The Hebrew + characters will be printed on the key next to the English characters. +@level: indicates which symbol on the key will be used, in a vertical direction. So on a standard US keyboard, the key with the number "1" on it also has the + exclamation point ("!") character on it. The level indicates whether to use + the "1" or the "!" symbol. The letter keys are considered to have a lowercase + letter at level 0, and an uppercase letter at level 1, though only the + uppercase letter is printed. @@ -182,12 +196,12 @@ Returns: %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL. Converts a key value into a symbolic name. -The names are the same as those in the <gdk/gdkkeysyms.h> header file +The names are the same as those in the <gdk/gdkkeysyms.h> header file but without the leading "GDK_". @keyval: a key value. -@Returns: a string containing the name of the key, or NULL if @keyval is not +@Returns: a string containing the name of the key, or %NULL if @keyval is not a valid key. The string should not be modified. @@ -233,21 +247,21 @@ in lower case or it is not subject to case conversion. -Returns TRUE if the given key value is in upper case. +Returns %TRUE if the given key value is in upper case. @keyval: a key value. -@Returns: TRUE if @keyval is in upper case, or if @keyval is not subject to +@Returns: %TRUE if @keyval is in upper case, or if @keyval is not subject to case conversion. -Returns TRUE if the given key value is in lower case. +Returns %TRUE if the given key value is in lower case. @keyval: a key value. -@Returns: TRUE if @keyval is in lower case, or if @keyval is not subject to +@Returns: %TRUE if @keyval is in lower case, or if @keyval is not subject to case conversion. diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml index 51337cabc6..72c0ded372 100644 --- a/docs/reference/gdk/tmpl/windows.sgml +++ b/docs/reference/gdk/tmpl/windows.sgml @@ -838,11 +838,12 @@ backend, MSGs for Win32). - +A special value for GdkPixmap* variables, indicating +that the background pixmap for a window should be inherited from the parent +window. - -- 2.30.2